Skip to main content

dropboxListFolderMembers

Type​

command

Summary​

Returns shared folder membership by its folder ID.

Syntax​

dropboxListFolderMembers <pAccessToken>, <pSharedFolderId>, [<pActions>, <pLimit>, <pCallback>]

Description​

Apps must have full Dropbox access to use this endpoint.

If a cursor is present then use the value with dropboxListFolderMembersContinue to obtain more results.

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

  • The request ID which will be the value of the it variable after calling the command
  • The HTTP response code
  • The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters​

NameTypeDescription

pAccessToken

An OAuth2 Access token to access the user's account

pSharedFolderId

The ID for the shared folder.

pActions

This is a list indicating whether each returned member will include a boolean value MemberPermission.allow that describes whether the current user can perform the member Aaction on the member. This field is optional.

Actions that may be taken on members of a shared folder. The value will be one of the following datatypes. New values may be introduced as our API evolves.

  • "leave_a_copy": Allow the member to keep a copy of the folder when removing.
  • "make_editor": Make the member an editor of the folder.
  • "make_owner": Make the member an owner of the folder.
  • "make_viewer": Make the member a viewer of the folder.
  • "make_viewer_no_comment": Make the member a viewer of the folder without commenting permissions.
  • "remove": Remove the member from the folder.

pLimit

The maximum number of results that include members, groups and invitees to return per request. The default for this field is 1000.

pCallback

The handler to call when the request is complete. If empty the command will block until complete.